Inclusiveness
  • 23 Sep 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Inclusiveness

  • Dark
    Light

Article summary

Inclusiveness is the practice of ensuring that the document is accessible and understandable to a diverse audience, including people with different backgrounds, experiences, and abilities.

Best practices

  1. Use plain language
    Technical documentation can be written in a way that is accessible to readers who may not have a technical background. This can be achieved by using plain language and avoiding jargon, technical terms, or complex sentence structures.

  2. Include alt text for images
    Alt text is a description of an image that is displayed when the image cannot be displayed. Adding it allows people with visual impairments to understand the content of the image.

  3. Use headings and subheadings
    Headings and subheadings help to break up the text and make it easier to scan and understand. They also help people using assistive technology, such as screen readers, navigate the document more easily.

  4. Provide examples
    Adding examples can help readers understand and apply the information being presented. It is important to provide examples that are relevant and relatable to a diverse audience.


Was this article helpful?

What's Next
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence